Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reworked documentation and formalize test suite #19

Merged
merged 12 commits into from
Apr 10, 2024

Conversation

Helveg
Copy link
Contributor

@Helveg Helveg commented Mar 22, 2024

This PR addresses 2 issues:

  • The test suite was not documented, and its dependencies not specified
  • The documentation was minimal, and hard to extend to a multi document structure, or to add new information that does not belong in the dashing module docstring.

Test suite

  • Add test extra dependencies and add them to the dev extra dependencies.
  • Make the pytest suite exit as gracefully as possible with a failing exit code on Windows.
    • pexpect does not support spawn, and the alternative cross-platform API pexpect.spawn_popen.SpawnPopen doesn't seem to support enough features for our use case

Documentation

  • Add docs extras and add them to the dev extra dependencies.
  • Decouple the documentation from the dashing module docstring, while maintaining it without duplication for the Overview section
  • Add a Developers section with the test suite docs
  • Add a Getting Started guide (still needs work to continue beyond the basics, e.g., example of each family of tiles and how to make your own tile)
  • Add autosummary to generate a full API reference, that wouldn't need to be maintained if we add new submodules or restructure the package.
  • Switch theme to furo, I personally find it less visually cluttering than alabaster, and it plays together nicely with sphinx-design (not added yet) if we want to start including some more modern/Material UI in the docs like tabs, code blocks, badges, buttons, cards, ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is to prevent a missing static path '_static' error during build

docs/.gitignore Show resolved Hide resolved
@Helveg Helveg changed the title Document test suite and specify dependencies Reworked documentation Mar 22, 2024
@Helveg Helveg changed the title Reworked documentation Reworked documentation and formalize test suite Mar 22, 2024
@Helveg Helveg marked this pull request as draft March 22, 2024 13:28
@Helveg Helveg marked this pull request as ready for review March 22, 2024 16:08
@FedericoCeratto FedericoCeratto merged commit 6f93628 into FedericoCeratto:master Apr 10, 2024
0 of 3 checks passed
@FedericoCeratto
Copy link
Owner

Thanks for the excellent contribution!

@Helveg Helveg deleted the pytest branch April 11, 2024 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants